Astro Scheduler Engine REST API
There are a number of commands for the Astro Scheduler Engine module that can be executed through REST API commands. These commands allow you to define and modify Astro Scheduler tasks and resources, retrieve task and resource information, and request schedule solutions. A brief description of the command as well as the command format and structure is provided for each command.
| Command | HTTP Request | Description | Version |
|---|---|---|---|
| File Parameters | |||
| Ingest Astro Scheduler Engine Command File | POST api/schedule/IngestCommands | Open a file and processes the connect commands contained in that file. | 12.3 |
| Export Schedule to Excel File | POST api/schedule/ExportToExcel | Create Excel file of Data view | 12.3 |
| Export Image of Gantt View | POST api/schedule/ExportGraphic | Create image file of Gantt view | 12.3 |
| Export Schedule to CSV File | POST api/schedule/ExportToCSV | Create CSV file of Data view | 12.3 |
| Export to Astro Scheduler Engine Command File | POST api/schedule/ExportToCommands | Create a text file of commands that will recreate the current schedule. | 12.3 |
| Merge Two Schedules | POST api/schedule/Merge | Merge 2 Schedules into a New Schedule File | 12.3 |
| Print Gantt View | POST api/schedule/PrintGantt | Prints the Gantt view and sets printing parameters | 12.3 |
| Print Table View | POST api/schedule/PrintTable | Prints the Table view and sets printing parameters | 12.3 |
| Resource Parameters | |||
| NewResource | POST api/resource/{resourceName} | Create a new Astro Scheduler resource object | 12.3 |
| EditResource | PATCH api/resource/{resourceName} | Set the value of Astro Scheduler resource object attributes | 12.3 |
| CreateResourceTag |
POST api/ResourceTag POST api/ResourceTag/{tagName} |
Creates a Resource Tag | 12.5 |
| EditResourceTag |
PATCH api/ResourceTag PATCH api/ResourceTag/{tagName} |
Edits a Resource Tag | 12.5 |
| DeleteResourceTag |
DELETE api/ResourceTag DELETE api/ResourceTag/{tagName} |
Delete specified resource tag object | 12.5 |
| DeleteResource |
DELETE api/resource DELETE api/resource/{resourceName} |
Delete specified resource object | 12.3 |
| CreateResConstraintGroup |
POST api/ResourceConstraintGroup POST api/ResourceConstraintGroup/{groupName} |
Create a resource constraint group | 12.3 |
| CreateResTemplateGroup | POST api/ResourceTemplateGroup | Create a resource template group | 12.3 |
| EditResConstraintGroup |
PATCH api/schedule/{scheduleName}/ResourceConstraintGroup/{groupName} PATCH api/ResourceConstraintGroup/{groupName} |
Updates a resource constraint group | 12.3 |
| EditResTemplateGroup | POST api/ResourceTemplateGroup | Updates a resource template group | 12.3 |
| DeleteResourceLogicalGroup |
DELETE api/ResourceConstraintGroup DELETE api/ResourceConstraintGroup/{groupName} |
Delete specified resource logical group object | 12.3 |
| IngestSTKObjects |
POST api/schedule/{scheduleName}/IngestSTKObjects POST api/IngestSTKObjects |
Create resources in Astro Scheduler Engine associated with objects in an STK scenario | 12.3 |
| GetResourceInfo |
POST api/report/resource/plain GET api/report/resource/{resourceName}/plain |
Return the attributes of the specified Astro Scheduler resource object | 12.3 |
| GetResourceInfoJson |
POST api/report/resource GET api/report/resource/{resourceName} |
Return the attributes of the specified Astro Scheduler resource object in JSON format | 12.3 |
| GetResourceValues |
POST api/report/ResourceValues/plain GET api/report/ResourceValues/{resourceName}/plain |
Return the resource attribute value timeline report | 12.3 |
| GetResourceValuesJson |
POST api/report/ResourceValues GET api/report/ResourceValues/{resourceName} |
Return the resource attribute value timeline report in JSON format | 12.3 |
| RfiResourceReportCsv | POST api/report/RfiResourceReportCsv | Returns data in .CSV format containing the RFI periods associated with the resource/resources listed in the parameters | 12.8 |
| UpdateOrbitData |
POST api/resource/{resourceName}/OrbitData POST api/schedule/{scheduleName}/resource/{resourceName}/OrbitData |
Update the orbit data for a given object in the associated STK scenario | 12.5 |
| ExportOrbitDataFile |
GET api/resource/{resourceName}/OrbitData/File GET api/schedule/{scheduleName}/resource/{resourceName}/OrbitData/File |
Download the orbit data for a given object in the associated STK scenario | 12.5 |
| GetOrbitDataPath |
GET api/resource/{resourceName}/OrbitData/File GET api/schedule/{scheduleName}/resource/{resourceName}/OrbitData/File |
Return the file location of the orbit data used by STK for the specified resource | 12.5 |
| UpdateAzElMask |
PATCH api/resource/{resourceName}/AzElMask PATCH api/schedule/{scheduleName}/resource/{resourceName}/AzElMask |
Update the azimuth-elevation mask for a given object in the associated STK scenario | 12.8 |
| ExportAzElMaskFile |
POST api/resource/{resourceName}/AzElMask/File POST api/schedule/{scheduleName}/resource/{resourceName}/AElMask/File |
Download the azimuth-elevation mask for a given object in the associated STK scenario | 12.8 |
| GetAzElMaskPath |
GET api/resource/{resourceName}/AzElMask/File GET api/schedule/{scheduleName}/resource/{resourceName}/AzElMask/File |
Return the file location of the azimuth-elevation mask used by STK for the specified resource | 12.8 |
| UpdateFirstPassNumber |
POST api/resource/{resourceName}/FirstPassNumber POST api/schedule/{scheduleName}/resource/{resourceName}/FirstPassNumber |
Update the pass numbering data for a given object in the associated STK scenario | 12.8 |
| Task Parameters | |||
| NewTask | POST api/task/{taskName} | Create a new Astro Scheduler task object | 12.3 |
| EditTask | PATCH api/task/{taskName} | Set the value of Astro Scheduler task object attributes | 12.3 |
| EditTaskGroup | PATCH api/TaskGroup/{groupName} | Set the value of Astro Scheduler task group object attributes | 12.3 |
| DeleteTask |
DELETE api/task DELETE api/task/{taskName} |
Delete specified task object | 12.3 |
| DeleteTaskGroup |
DELETE api/TaskGroup DELETE api/TaskGroup/{groupName} |
Delete specified task group object | 12.3 |
| NewAssignment |
POST api/task/{taskID}/assignment POST api/schedule/{scheduleName}/task/{taskID}/assignment |
Create a new assignment for an Astro Scheduler task object | 12.5 |
| EditAssignment |
PATCH api/task/{taskID}/assignment/{assignmentID} PATCH api/schedule/{scheduleName}/task/{taskID}/assignment/{assignmentID} |
Edit an assignment for an Astro Scheduler Engine object | 12.5 |
| DeleteAssignment |
DELETE api/task/{taskID}/assignment/{assignmentID} DELETE api/schedule/{scheduleName}/task/{taskID}/assignment/{assignmentID} |
Deletes an assignment for an Astro Scheduler task object | 12.5 |
| GetTaskInfo |
POST api/report/task/plain GET api/report/task/{taskName}/plain |
Return the attributes of the specified Astro Scheduler task object | 12.3 |
| GetTaskInfoJson |
POST api/report/task GET api/report/task/{taskName} |
Return the attributes of the specified Astro Scheduler task object in JSON format | 12.3 |
| LockTasks | POST api/task/Lock | Change Lock Status of Specified Tasks | 12.3 |
| LockSingleAssignment |
POST api/task/{taskID}/assignment/{assignmentID}/Lock POST api/schedule/{scheduleName}/task/{taskID}/assignment/{assignmentID}/Lock |
Locks or unlocks a single assignment for an Astro Scheduler task object | 12.5 |
| LockMultipleAssignments |
POST api/task/{taskID}/assignment/Lock POST api/schedule/{scheduleName}/task/{taskID}/assignment/Lock |
Locks or unlocks all or subset of assignments for an Astro Scheduler task object | 12.5 |
| HideTasks | POST api/task/Hide POST api/task/Unhide | Change Visible Status of Specified Tasks | 12.3 |
| DeferTasks | POST api/task/Defer | Change Deferred Status of Specified Tasks | 12.3 |
| GetTaskGroupReport |
POST api/schedule/{scheduleName}/report/TaskGroup/plain POST api/report/TaskGroup/plain GET api/schedule/{scheduleName}/report/TaskGroup/{taskName}/plain GET api/report/TaskGroup/{taskName}/plain |
Return the Task Group report | 12.3 |
| GetTaskGroupReportJson |
POST api/schedule/{scheduleName}/report/TaskGroup POST api/report/TaskGroup GET api/schedule/{scheduleName}/report/TaskGroup/{taskName} GET api/report/TaskGroup/{taskName} |
Return the Task Group report in JSON format | 12.3 |
| GetTaskConflicts |
POST api/schedule/{scheduleName}/task/Conflicts POST api/task/Conflicts GET api/schedule/{scheduleName}/task/Conflicts GET api/task/Conflicts |
Return the Task Conflicts report | 12.3 |
| RecreatePossibilities |
POST api/RecreatePossibilities POST api/schedule/{scheduleName}/RecreatePossibilities |
Re-create task possibilities | 12.3 |
| LockTaskAssignments |
POST api/task/assignment/Lock POST api/schedule/{scheduleName}/task/assignment/Lock |
Re-create task possibilities | 12.6 |
| Schedule Parameters | |||
| NewSchedule |
POST api/schedule/{scheduleName} POST api |
Open a new blank Astro Scheduler Engine schedule file to work with | 12.3 |
| OpenSchedule | POST api/Load | Open an existing Astro Scheduler Engine schedule file to work with | 12.3 |
| ValidateSchedule |
POST api/schedule/{scheduleName}/Validate POST api/Validate |
Initiate schedule validation | 12.3 |
| DeconflictSchedule | POST api/schedule/{scheduleName}/Deconflict POST api/Deconflict | Request a new schedule solution | 12.3 |
| StopDeconflict | POST api/StopDeconflict | Abort the current deconfliction run | 12.3 |
| CloseSchedule | POST api/Close | Close the active Schedule | 12.3 |
| GetScheduleInfo |
POST api/schedule/{scheduleName}/report/schedule/plain POST api/report/schedule/plain |
Return the current values of Astro Scheduler Engine option settings | 12.3 |
| GetScheduleInfoJson |
GET api/schedule/{scheduleName}/report/schedule GET api/report/schedule |
Return the current values of Astro Scheduler Engine option settings in JSON format | 12.3 |
| GetScheduleComparisonReport |
POST api/schedule/{scheduleName}/report/comparison/plain POST api/report/comparison/plain |
Return a schedule comparison report | 12.3 |
| GetScheduleComparisonReportJson |
POST api/schedule/{scheduleName}/report/comparison POST api/report/comparison |
Return a schedule comparison report in JSON format | 12.3 |
| GetScheduleSolution |
GET api/schedule/{scheduleName}/report/schedule/solution/plain GET api/report/schedule/solution/plain |
Return a schedule summary report | 12.3 |
| GetScheduleSolutionJson | GET api/report/schedule/solution | Return a schedule summary report in JSON format | 12.3 |
| GetVersion | GET api/Version | Return the current version of Astro Scheduler Engine | 12.3 |
| GetPluginVersion | GET api/PluginVersion | Return the current version of Astro Scheduler Engine's Plugins | 12.3 |
| Export RFI Configuration | GET api/report/ExportRfiConfiguration | Exports the schedule's resource RFI configurations in .JSON | 12.8 |
| Import RFI Configuration | POST api/ImportRfiConfiguration | Imports resource RFI configurations into the schedule | 12.8 |
| SaveSchedule |
POST api/schedule/{scheduleName}/Save POST api/Save |
Save the Astro Scheduler Engine schedule file | 12.3 |
| SetScheduleOptions |
POST api/schedule/{scheduleName}/Options POST api/Options |
Set the value of Astro Scheduler Engine option setting(s) | 12.3 |
| EditFOM |
PATCH api/schedule/{scheduleName}/Fom PATCH api/Fom |
Set Figure of Merit (FOM) value(s) | 12.6 |
| AnimateSchedule | POST api/schedule/{scheduleName}/Animate POST api/Animate | Animates the Active Schedule in STK | 12.3 |
| GetBufferTimeUsage |
POST api/BufferTimeUsage GET api/BufferTimeUsage/{resourceName} POST api/schedule/{scheduleName}/BufferTimeUsage GET api/achedule/{scheduleName}/BufferTimeUsage/{resourceName} |
Returns the names of all tasks with an assignment within the specified resource's buffer time. If any tasks are unassigned, they will also be returned if they have any timeslots within the specified resource's buffer time | 11.6 |
| Ancillary Parameters | |||
| NewCustomSTKReport |
POST api/schedule/{scheduleName}/CustomSTKReport POST api/CustomSTKReport |
Make a new, custom report format, a new way of pulling data from STK. | 12.3 |
| GetCustomSTKReports |
GET api/schedule/{scheduleName}/CustomSTKReports GET api/CustomSTKReports |
Get the definitions for all user-created custom STK reports. | 12.7 |
| DeleteCustomSTKReport |
DELETE api/schedule/{scheduleName}/CustomSTKReport DELETE api/CustomSTKReport |
Deletes custom STK report formats with the name "CustomName". | 12.3 |
| BatchUpdateStkReportDefs |
POST /api/schedule/{scheduleName}/BatchUpdateStkReportDefs POST /api/schedule/BatchUpdateStkReportDefs |
Updates the STK report definition for all existing reports on resources and/or tasks | 12.9 |
| RefreshStkData |
POST api/schedule/{scheduleName}/RefreshSTKData POST api/RefreshSTKData |
Refresh all Task and Resource reports from STK | 12.3 |
| GetConfigOptionsJson | GET api/Config | Get the Astro Scheduler Engine configuration settings | 12.3 |
| SetConfigOptions | POST api/Config | Set the value of Astro Scheduler Engine configuration setting(s) | 12.3 |
| SetTimescaleOptions | POST api/schedule/TimescaleOptions | Control Gantt view timescale settings | 12.3 |
| SetViewOptions |
POST api/schedule/{scheduleName}/ViewOptions POST api/ViewOptions |
Control GUI window settings | 12.3 |
| Shutdown | POST api/Shutdown | Closes the Astro Scheduler Engine application when only the Astro Scheduler Engine engine is running. | 12.3 |
| STK |
POST api/schedule/{scheduleName}/STK POST api/STK |
Send an STK Connect command through Astro Scheduler Engine to STK, and get the response. | 12.3 |
| StoreFile | POST api/StoreFile | Sends a file to be stored. | 12.3 |
| UpdateTimeComponents |
POST api/schedule/{scheduleName}/UpdateTimeComponents POST api/UpdateTimeComponents |
Updates TimeComponents in the STK Timeline View. | 12.3 |
